Deletes the specified items in the specified vault.
(Body parameter) Array of folder IDs
Member of DeleteComputeTree model
(Body parameter) Array of file IDs
(Body parameter) Whether to destroy
(Response) Number of files deleted
Member of DelResult model
(Response) Number of folders deleted
(Response) An XRefWarning object that consists of:
ParentProjectID (integer)
ObjectType (PweObjectType that is one of:
ObjType_NoObject = 0
ObjType_File= 1
ObjType_InternalComponent = 2
ObjType_SavedBOM = 3
ObjType_Item = 4
ObjType_CutListItem = 5
)
ChildObjectType (PweObjectType; see ObjectType)
DocumentID (integer)
Version (integer)
ChildDocumentID (integer)
ChildProjectID (integer)
ChildVersion (integer)
This operation:
The complete DelResult model consists of:
FileCount (integer)
FolderCount (integer)
XRefWarnings (array of XRefWarning objects; each XRefWarning consists of:
BranchRefWarnings (array of BranchRefWarning objects; each BranchRefWarning consists of:
ProjectID (integer)
ObjectType (PweObjectType; see XRefWarnings)
BranchName (string)
BranchDeleted (integer)
LockedFiles (array of LockInfo2 objects; each LockInfo2 consists of:
ObjectType (integer)
ObjectType (PweObjectType; see BranchRefWarnings)
UserID (integer)
InUserState (boolean)
FileNames (dictionary of integer [key] and string [value] pairs)
UserNameMap (dictionary of integer [key] and string [value] pairs)
FolderPaths (dictionary of integer [key] and string [value] pairs)
LocalFiles (array of strings)
LocalFolders (array of strings)
VaultItems (array of DeleteItem objects; each DeleteItem consists of:
Flags (integer)
Provide feedback on this topic
SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.
* Required
Thank you for your comments. We will contact you if we have questions regarding your feedback.
Sincerely,The SOLIDWORKS Documentation Team
Print Topic
Select the scope of content to print:
We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.
Web Help Content Version: API Help (English only) 2023 SP05 To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help. To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.